home *** CD-ROM | disk | FTP | other *** search
/ The CICA Windows Explosion! / The CICA Windows Explosion! - Disc 2.iso / programr / code_cnt.zip / README < prev   
Text File  |  1995-05-01  |  4KB  |  107 lines
  1. Code Counting Utility (ln) (c) 1995 - by Russ Vanderpool - Freeware
  2.  
  3. Overview
  4. --------
  5. This application does what it says. Namely, it counts lines of code. 
  6. This tool was initially, very quickly written, to count lines of code
  7. for a Microsoft(c) Visual C++ application that I was writing. 
  8.  
  9. While line counting tools are VERY easy to write, an attempt was made
  10. to create one with a half-decent interface. Additionally, this tool
  11. also provides the following functionality:
  12.    
  13.   -- Ability to count groups of files (for example, all *.h files,
  14.      resource files, etc.)
  15.   -- Ability to filter out specific files from the group of files
  16.      that you wish to count. (For example, in my project, I use
  17.      the "tabview.cpp" file. Obviously I did not write this, and did
  18.      not want this included in the number of lines that I had written.)
  19.   -- Also counts, and provides totals, for white space lines,
  20.      comments, and of course lines of actual code.
  21.  
  22. The code counting algorithm classifies lines starting with "//". and
  23. block comments "/*", any comments in-between, "*/", as comment lines.
  24.  
  25. White space lines are those lines containing only spaces and the EOL
  26. character.
  27.  
  28. Prior to determining whether a line in a file is a comment, white space,
  29. or a line of code, all spaces are stripped from the beginning and end,
  30. of the line.
  31.  
  32. This is a Windows 3.1 16-bit application.
  33.  
  34. Usage
  35. ------
  36.   File Menu:
  37.   ----------
  38.     "Select Source Directory... Ctrl-S" - selects the directory that
  39.        contains the source files you wish to count.
  40.  
  41.     "Count Source Lines Ctrl-N" - counts the source code/comments/white
  42.        space, of those files that are listed in the three list boxes.
  43.  
  44.   Main Window Buttons:
  45.   --------------------
  46.     "Select Directory" - selects the directory that contains the source 
  47.        files that you wish to count.
  48.  
  49.     "Populate Lists" - fills in the three list boxes with the file
  50.       names containing the file extensions that are selected in the 
  51.           combo boxes above each of the three list boxes.  (based on the 
  52.           directory that is specified in the "Code Directory" list box.)
  53.  
  54.     ">>" - initiates the line counting algorithm on the files that are
  55.       listed in the list boxes
  56.  
  57.     "Remove Highlighted Files" - removes the highlighted files names,
  58.       if any, from the three list boxes. (Can be used to filter
  59.       out file names that you do not wish to count)
  60.  
  61. Results
  62. -------
  63. Totals are given for all the files in each of the three list boxes. 
  64. Additionally, a grand total is then generated based on the totals
  65. of the three list boxes (if any).
  66.  
  67. If this utility is of any use, please drop me a note. Also, if you
  68. have any suggestions/bug problems, please report them to:
  69.  
  70.     rvanderp@lynx.northeastern.edu
  71.  
  72. Depending on my work schedule, I'll try to look into any problems/suggestions 
  73. that you might have.
  74.  
  75.  
  76. Installation
  77. ------------
  78. After downloading the code_cnt.zip archive, unpacking this archive 
  79. will create the following two files:
  80.     ln.exe
  81.     README (this file)
  82.  
  83. The only other requirement that must be fulfilled, is that you have 
  84. the CTL3D.DLL installed in your windows system directory.
  85.  
  86.     For Example:  c:\windows\system\ctl3d.dll
  87.         
  88.  
  89. That's it... Do what you want from here.
  90.  
  91. Disclaimer
  92. ----------
  93. Code Counting Utility (ln) is supplied as a Freeware utility/application. 
  94. The author offers no warranty as to the soundness of this utility/application,
  95. and accepts no liability for any loss or damage incurred by its use. This 
  96. is not a supported product/utility/application.
  97.  
  98. You are free to distribute this tool, provided that you do not charge any
  99. money for its distribution. Additionally, this README must be included. 
  100.  
  101. With that said, phew, comments and suggestions are always welcome. If 
  102. enough interest and suggestions are shown, I'll try to improve this utility.
  103.  
  104. Kind Regards,
  105. Russ Vanderpool
  106. rvanderp@lynx.northeastern.edu
  107.